docs: blog post on read-cache-after-write consistency#3194
Conversation
4ee62d8 to
d1d0133
Compare
0ea2ba4 to
16ea561
Compare
ebcf9bc to
10ccea7
Compare
There was a problem hiding this comment.
Pull request overview
Adds documentation content describing the new read-cache-after-write consistency feature and links it from existing release/blog pages; also adjusts an SSA patching integration test reconciler to use reschedule() behavior.
Changes:
- Add a new blog post explaining read-cache-after-write consistency and event filtering.
- Update the v5.3 release post and a deprecated blog post to link to the new blog post.
- Modify
PatchResourceWithSSAReconcilerto reschedule reconciliation (test behavior).
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 7 comments.
| File | Description |
|---|---|
| operator-framework/src/test/java/io/javaoperatorsdk/operator/baseapi/patchresourcewithssa/PatchResourceWithSSAReconciler.java | Changes how the test reconciler schedules the “next pass” reconciliation. |
| docs/content/en/blog/releases/v5-3-release.md | Adds a link to the new read-after-write consistency blog post from the 5.3 release notes. |
| docs/content/en/blog/news/read-after-write-consistency.md | New blog post describing the read-cache-after-write consistency feature and rationale. |
| docs/content/en/blog/news/primary-cache-for-next-recon.md | Updates deprecated post to reference the new docs/blog content for the replacement feature. |
You can also share your feedback on Copilot code review. Take the survey.
| res.getSpec().setControllerManagedValue(ADDED_VALUE); | ||
| // test assumes we will run this in the next reconciliation | ||
| return UpdateControl.patchResource(res).reschedule(); | ||
| return UpdateControl.<PatchResourceWithSSACustomResource>noUpdate().reschedule(); |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Adds a new documentation blog post explaining the new read-cache-after-write consistency guarantees introduced in v5.3.0, and links to it from existing release/news content so readers can find the deeper rationale and details.
Changes:
- Link the v5.3 release notes to a new “read-after-write consistency” blog post.
- Add a new blog post describing the problem space, algorithm, and event filtering behavior.
- Update the older “primary cache for next reconciliation” post to point readers to the new docs + blog post.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| docs/content/en/blog/releases/v5-3-release.md | Adds a link from release notes to the new blog post. |
| docs/content/en/blog/news/read-after-write-consistency.md | New long-form post describing read-cache-after-write consistency + event filtering. |
| docs/content/en/blog/news/primary-cache-for-next-recon.md | Updates deprecation note to reference the new docs/blog post. |
You can also share your feedback on Copilot code review. Take the survey.
| is not required anymore. See the [docs](./../../docs/documentation/reconciler.md#read-cache-after-write-consistency-and-event-filtering) and | ||
| related [blog post](read-after-write-consistency.md) for details. |
|
|
||
| Having the TRC has an additional advantage: since we have the resource instantly in our caches, we can | ||
| elegantly continue the reconciliation in the same pass and reconcile resources that depend | ||
| on the latest state. More concretely, this also helps with our [Dependent Resources / Workflows](../../docs/documentation/dependent-resource-and-workflows/workflows.md#reconcile-sample) |
| is not required anymore. See the [docs](./../../docs/documentation/reconciler.md#read-cache-after-write-consistency-and-event-filtering) and | ||
| related [blog post](read-after-write-consistency.md) for details. |
Signed-off-by: Attila Mészáros a_meszaros@apple.com